home *** CD-ROM | disk | FTP | other *** search
/ 3D GFX / 3D GFX.iso / amiutils / i_l / jacosub / documentation / quickref.doc < prev    next >
Text File  |  1995-12-30  |  11KB  |  319 lines
  1. JACOsub Quick Reference
  2. =======================
  3.  
  4. This document serves as a brief summary to JScripts.doc.  Refer to
  5. JScripts.doc for complete details.
  6.  
  7.  
  8. SCRIPT COMPILER COMMANDS
  9. ========================
  10.  
  11. #  (followed by a space) Comment.  The line will be ignored.
  12.  
  13. #C[LOCKPAUSE] <time>
  14.    Force clock to pause at time specified while playing.  Keypress resumes.
  15.  
  16. #D[IRECTIVE][n] <directive string>
  17.    Change default directive n.  n=0 (overall directive) if n omitted.
  18.    n may range from 0 to 9.
  19.  
  20. #F[ONT] <n> <fontname.font> <h> [CLEAN or QUICK&DIRTY] [Y/X]
  21.    Set font n to fontname.font, h pixels tall.  n may range from 0 to 9.
  22.    Mono fonts are always QUICK&DIRTY (rendered fast).
  23.    For face colors other than 3, color fonts default to CLEAN (rendered
  24.    one character at a time), unless QUICK&DIRTY is specified.
  25.    Y/X is used to change the aspect ratio from 1/1 (AmigaDOS 2.0+).
  26.  
  27. #I[NCLUDE] <time> <filename>
  28.    Include script file <filename> into the current script, offsetting
  29.    the new script's start time by the time specified.  Offset cannot be
  30.    negative.  Offset units depend on time units set by #TIMERES.
  31.    #F, #P, #Q, and #R in an included script will be ignored.
  32.    The effects of #D, #S, and #T are passed down into included scripts.
  33.  
  34. #P[ALETTE] <color> <r> <g> <b> [palette]
  35.    For specified color register, set RGB intensities (0 to 15).  palette
  36.    defaults to 0 (primary palette), but may be 0 through 9.  Use palettes
  37.    1 - 9 with the CP directive.
  38.  
  39. #Q[UANTIZE][n]
  40.    Eliminate timing gaps between subtitles of less than n time units.
  41.    Number of time units per second is specified by #TIMERES.
  42.  
  43. #R[AMP] <seconds.units>
  44.    Adjust script play for time drift by changing the script's overall
  45.    running time.  Positive ramp adjustments lengthen the play, negative
  46.    adjustments shorten it.  Time units are determined by #TIMERES.
  47.  
  48. #S[HIFT] <[[hours:]minutes:]seconds.units>
  49.    Shift all times in script by the amount specified.  Positive shifts
  50.    delay time events, negative shifts advance them.
  51.  
  52. #T[IMERES] <n>
  53.    Set time resolution of script to n units per second.  Default is 30
  54.    if this command does not appear in the script.
  55. ESCAPE CODES TO EMBED IN TITLES
  56. ===============================
  57.  
  58. \   Concatenate.  Assume next line in script continues current title.
  59.     Leading and trailing spaces in concatenated lines are ignored.
  60.  
  61. \n  Newline.  Use to split a title text into multiple lines.  \n codes
  62.     override wordwrapping, but the resulting text substrings might still
  63.     be individually wordwrapped if needed.
  64.  
  65. \{  Display a left brace, which is normally used to begin a non-displaying
  66.     comment embedded in the title.
  67.  
  68. \~  Display a tilde, which is normally used to create a "hard" non-
  69.     wrappable space.
  70.  
  71. \\  Display a backslash, which is normally used to begin an escape code.
  72.  
  73. \N  Normal.  Display text that follows in "normal" style.  Equivalent to
  74.     the SN directive.
  75.  
  76. \I  Italics. Display text that follows in italics.  Equivalent to the SI
  77.     directive.
  78.  
  79. \B  Boldface.  Display text that follows in boldface (sometimes useful).
  80.     Equivalent to the SB directive.
  81.  
  82. \U  Underline.  Underline text that follows (not useful).  Equivalent to
  83.     the SU directive.
  84.  
  85.     Note: /N, /I, /B, and /U are mutually exclusive.
  86.  
  87. \Cn Color n.  Use face color n for text that follows.  n is a hexadecimal
  88.     digit ranging from 0 to 9 and A to F (or a to f).  Equivalent to the
  89.     CF directive.
  90.  
  91. \Fn Font n.  Use font n (0 to 9) for text that follows.  Equivalent to the
  92.     F directive.
  93. TITLE DIRECTIVES
  94. ================
  95. Directives occur after the stop time is specified.  You may omit the title
  96. directive if you title begins with a non-alphabet character (such as a left
  97. brace for a {comment}), in which case the directive defaults to D.
  98.  
  99. Vertical positioning
  100. --------------------
  101.  
  102.   VA
  103.      Vertical continuation Above previous title, using previous title's
  104.      vertical positioning setting.  Opposite of VU.
  105.  
  106.   VB[n]
  107.      Vertical Bottom, offset from bottom of display by n pixels.  n may
  108.      be omitted (default n, usually 16, can be set with the #D command).
  109.  
  110.   VHn
  111.      Vertical line Height n% of normal.  VH200 makes double-spaced lines.
  112.  
  113.   VL[n]
  114.      Vertical Line position n.  Line height depends on font size.  If n is
  115.      negative or omitted, vertical line position will be where the previous
  116.      timed line started.
  117.  
  118.   VM[n]
  119.      Vertical Middle.  Center vertically between VTn and VBn position.
  120.      n=0 by default, otherwise shifts block up or down n text lines.
  121.  
  122.   VPn
  123.      Vertical Pixel position n.  Baseline of font will be n pixels from
  124.      top of display.
  125.  
  126.   VSn
  127.      Not yet implemented; doesn't do anything yet.  Don't ask.
  128.  
  129.   VT[n]
  130.      Vertical Top, offset from top of display by n pixels.  n may be
  131.      omitted (default n, ususally 16, can be set with the #D command).
  132.  
  133.   VU
  134.      Vertical continuation Under previous title, using previous title's
  135.      vertical positioning setting.  Opposite of VA.
  136.  
  137. Horizontal positioning
  138. ----------------------
  139.  
  140.  Margins:
  141.  
  142.   HLn
  143.      Horizontal Left margin n% of display width from left edge.
  144.  
  145.   HRn
  146.      Horizontal Right margin n% of display width from right edge.
  147.  
  148.  Text justification:
  149.  
  150.   JC
  151.      Justify Center.  Text is centered within HLn - HRn constraints.
  152.  
  153.   JF[:p]
  154.      Justify Full.  Aligns left and right edges with the ends of the
  155.      widest line in the text box.  Last line in block is unaffected, except
  156.      to position it Left, Right, or Center (default), when :p is :L, :R, or
  157.      :C, respectively.  JF:U means Unconditional justification -- ALL lines
  158.      in the block will be stretched to fit exactly within the margins.
  159.  
  160.   JL
  161.      Justify Left.  Align left edge of text at the HLn margin position.
  162.  
  163.   JR
  164.      Justify Right.  Align right edge of text at the HRn margin position.
  165.  
  166.  Block justification:
  167.  
  168.   JBC
  169.      Justify Block Center.  Position the text, after wordrwapping, so that
  170.      it is centered within the margins, preserving the text justification.
  171.      To get "AnimEigo" positioning, use JBC with JL.
  172.  
  173.   JBF
  174.      Justify Block Full.  Cancel the effect of any JB directive if one
  175.      happens to be in use as a default directive.
  176.  
  177.   JBL
  178.      Justify Block Left.  Position the text block at the left margin.
  179.  
  180.   JBR
  181.      Justify Block Right.  Position the text block so that the right
  182.      edge is at the right margin, preserving the text justification.
  183.  
  184.  Word wrapping:
  185.  
  186.   W0
  187.      Disable automatic word wrapping.  Warning: text may overflow screen
  188.      boundaries.
  189.  
  190.   W1
  191.      Automatic "smart" word wrapping (default).  Wrap text so that the
  192.      screen area consumed by the title is minimized.
  193.  
  194.   W2
  195.      Automatic "stupid" (generally known as "greedy") word wrapping.
  196.      Fit as much text into a line as possible without regard to appearance
  197.      or screen space consumed.
  198.  
  199. Fonts
  200. -----
  201.  
  202.  Font rendering:
  203.  
  204.   Fn
  205.      Use font n (0 - 9) for the title text.
  206.  
  207.   FQ
  208.      Force title to be rendered Quick&Dirty.  Mono-color fonts and
  209.      colorfonts using color 3 are always quick anyway.
  210.  
  211.   FC
  212.      Force title to be rendered Clean (1 character at a time) to avoid font
  213.      shadow overlap interference problems.rendering.  Mono-color fonts and
  214.      colorfonts using color 3 will still be rendered fast.
  215.  
  216.   FD
  217.      Force Default text rendering.  Used to override a global #DFC or #DFF
  218.      command.
  219.  
  220.   FOn[:a]
  221.      Generate Font Outline n pixels wide, optionally use antialias color a.
  222.      Warning:  This slows the program down considerably.
  223.  
  224.   FSdn
  225.      Generate Font Shadow in direction d (one of 8 compass directions
  226.      N, S, E, W, NW, NE, SW, SE), n pixels deep.
  227.  
  228.  Font style (may also be set with \ codes in the title text):
  229.  
  230.   SN
  231.      Normal style (typical default).
  232.  
  233.   SI
  234.      Italic.
  235.  
  236.   SB
  237.      Bold (using the JACOsub font, this looks best with color 3).
  238.  
  239.   SU
  240.      Underline (ugly!  Not recommended).
  241.  
  242.  Color
  243.  
  244.   CFn
  245.      Color Fontface n.
  246.  
  247.   CBn
  248.      Color Background n.  Screen is cleared to color n prior to rendering
  249.      anything to it.  Useful for creating a genlock-opaque background if
  250.      n is nonzero.
  251.  
  252.   CPn
  253.     Load Color Palette n (0 to 9, set with #PALETTE command) at the start
  254.     time of this title.  If you can see the palette change after the
  255.     display is updated, precede your alternate palette lines with a "dummy"
  256.     short-duration blank screen (containing a hard space) using your
  257.     alternate palette.
  258.  
  259.   CS[L]n[:s[:c]]
  260.     Color Shaded box with n-pixel margin around text, using shade style :s
  261.     (:0=pattern, :1=solid color), using optional color :c (normal default
  262.     is :2 [black], can be re-set with a #D command).  Titles that overlap
  263.     in time AND use the CS directive will be surrounded by a SINGLE box; if
  264.     CSL is used, a box will appear around individual lines (including
  265.     segments resulting from wordwrapping).  n=0 disables shading.
  266.  
  267. Genlock fader control
  268. ---------------------
  269.  
  270.   GBn[Tm]
  271.     Genlock Background n% of saturation in m/60 seconds.  m=0 if Tm is
  272.     omitted.  n=0 is a transparent background.
  273.  
  274.   GGn[Tm]
  275.     Genlock Graphics n% of saturation in m/60 seconds.  m=0 if Tm omitted.
  276.     n=100 is full-on graphics.
  277.  
  278.   Note:  Do not use the G directives in the global #D command.
  279.  
  280. IFF graphic files
  281. -----------------
  282.  
  283.   IL <ILBM file name> [<x offset %> <y offset %>]
  284.     Load an IFF ILBM bitmap into the video screen for the time interval
  285.     specified by this line's start and stop time.  Current screen colors
  286.     will be used; the IFF colors will be ignored.  x and y are percents of
  287.     screen width and height to offset the center of the bitmap from the
  288.     center of the screen.  Through overlapping time ranges, as many as
  289.     40 images may be loaded onto a single screen, memory permitting.
  290.     Text can appear concurrently with the bitmaps.
  291.  
  292.   IS <ILBM file name>
  293.     Load an IFF ILBM file into its own screen, using the file's own
  294.     resolution and colors.  Text cannot appear concurrently.
  295.  
  296.   Note:  Do not use the I directives in the global #D command.
  297.  
  298. ARexx communications
  299. --------------------
  300.  
  301.   RX <ARexx script name>
  302.     Execute the ARexx script name that follows the RX directive.  Do not
  303.     specify other directives on the same line, and have no more than one
  304.     RX directive per time event.
  305.  
  306.   Note:  Do not use the RX directive in the global #D command.
  307.  
  308. Default directives
  309. ------------------
  310.  
  311.   D or D0
  312.     Default 0verall.  To be used if no other directives are used.  The
  313.     behavior of D can be set with the #D command.
  314.  
  315.   Dn
  316.     Default alternate n (1 - 9).  Use these for "shortcuts" to long
  317.     directive strings that you like to use repeatedly.  Set with the #D
  318.     command.
  319.